/* ###
 * IP: GHIDRA
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package generic.util;

import java.util.Iterator;

/**
 * Utilities for working with a {@link PeekableIterator}
 */
public enum PeekableIterators {
	;
	/**
	 * Ensure that the given iterator is peekable
	 * 
	 * <p>
	 * If it is already peekable, this casts it as such. If not, it wraps it in a peekable iterator.
	 * 
	 * @param <E> the type of elements
	 * @param it the iterator
	 * @return the peekable iterator
	 */
	public static <E> PeekableIterator<E> castOrWrap(Iterator<E> it) {
		if (it instanceof PeekableIterator<E> pi) {
			return pi;
		}
		return new WrappingPeekableIterator<E>(it);
	}
}
